

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>Welcome to KoSpeech’s documentation! &mdash; KoSpeech 0.0 documentation</title>
  

  
  
  
  

  
  <script type="text/javascript" src="_static/js/modernizr.min.js"></script>
  
    
      <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
        <script type="text/javascript" src="_static/jquery.js"></script>
        <script type="text/javascript" src="_static/underscore.js"></script>
        <script type="text/javascript" src="_static/doctools.js"></script>
    
    <script type="text/javascript" src="_static/js/theme.js"></script>

    

  
  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="Intro" href="notes/intro.html" /> 
</head>

<body class="wy-body-for-nav">

   
  <div class="wy-grid-for-nav">
    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
          

          
            <a href="#" class="icon icon-home"> KoSpeech
          

          
          </a>

          
            
            
              <div class="version">
                0.0
              </div>
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <p class="caption"><span class="caption-text">NOTES</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="notes/intro.html">Intro</a></li>
<li class="toctree-l1"><a class="reference internal" href="notes/Preparation.html">Preparation before Training</a></li>
<li class="toctree-l1"><a class="reference internal" href="notes/opts.html">Options</a></li>
</ul>
<p class="caption"><span class="caption-text">ARCHITECTURE</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="Seq2seq.html">Seq2seq</a></li>
<li class="toctree-l1"><a class="reference internal" href="Transformer.html">Transformer</a></li>
</ul>
<p class="caption"><span class="caption-text">PACKAGE REFERENCE</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="Checkpoint.html">Checkpoint</a></li>
<li class="toctree-l1"><a class="reference internal" href="Data.html">Data</a></li>
<li class="toctree-l1"><a class="reference internal" href="Decode.html">Decode</a></li>
<li class="toctree-l1"><a class="reference internal" href="Evaluator.html">Evaluator</a></li>
<li class="toctree-l1"><a class="reference internal" href="Optim.html">Optim</a></li>
<li class="toctree-l1"><a class="reference internal" href="Trainer.html">Trainer</a></li>
<li class="toctree-l1"><a class="reference internal" href="Etc.html">Etc</a></li>
</ul>

            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="#">KoSpeech</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="#">Docs</a> &raquo;</li>
        
      <li>Welcome to KoSpeech’s documentation!</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            <a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
          
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="welcome-to-kospeech-s-documentation">
<h1>Welcome to KoSpeech’s documentation!<a class="headerlink" href="#welcome-to-kospeech-s-documentation" title="Permalink to this headline">¶</a></h1>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">NOTES</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="notes/intro.html">Intro</a></li>
<li class="toctree-l1"><a class="reference internal" href="notes/Preparation.html">Preparation before Training</a></li>
<li class="toctree-l1"><a class="reference internal" href="notes/opts.html">Options</a></li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">ARCHITECTURE</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="Seq2seq.html">Seq2seq</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Seq2seq.html#module-kospeech.models.seq2seq.encoder">Seq2seqEncoder</a></li>
<li class="toctree-l2"><a class="reference internal" href="Seq2seq.html#module-kospeech.models.seq2seq.decoder">Seq2seqDecoder</a></li>
<li class="toctree-l2"><a class="reference internal" href="Seq2seq.html#id1">Seq2seq</a></li>
<li class="toctree-l2"><a class="reference internal" href="Seq2seq.html#module-kospeech.models.seq2seq.attention">Attention</a></li>
<li class="toctree-l2"><a class="reference internal" href="Seq2seq.html#module-kospeech.models.modules">Modules</a></li>
<li class="toctree-l2"><a class="reference internal" href="Seq2seq.html#module-kospeech.models.seq2seq.sublayers">Sublayers</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Transformer.html">Transformer</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Transformer.html#id1">Transformer</a></li>
<li class="toctree-l2"><a class="reference internal" href="Transformer.html#module-kospeech.models.transformer.layers">Layers</a></li>
<li class="toctree-l2"><a class="reference internal" href="Transformer.html#module-kospeech.models.transformer.sublayers">Sublayers</a></li>
<li class="toctree-l2"><a class="reference internal" href="Transformer.html#module-kospeech.models.transformer.embeddings">Embeddings</a></li>
<li class="toctree-l2"><a class="reference internal" href="Transformer.html#module-kospeech.models.transformer.mask">Mask</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">PACKAGE REFERENCE</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="Checkpoint.html">Checkpoint</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Checkpoint.html#id1">Checkpoint</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Data.html">Data</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Data.html#module-kospeech.data.audio.augment">Augment</a></li>
<li class="toctree-l2"><a class="reference internal" href="Data.html#module-kospeech.data.audio.core">Core</a></li>
<li class="toctree-l2"><a class="reference internal" href="Data.html#module-kospeech.data.audio.feature">Feature</a></li>
<li class="toctree-l2"><a class="reference internal" href="Data.html#module-kospeech.data.audio.parser">Parser</a></li>
<li class="toctree-l2"><a class="reference internal" href="Data.html#module-kospeech.data.data_loader">DataLoader</a></li>
<li class="toctree-l2"><a class="reference internal" href="Data.html#module-kospeech.data.label_loader">LabelLoader</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Decode.html">Decode</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Decode.html#module-kospeech.decode.ensemble">Ensemble</a></li>
<li class="toctree-l2"><a class="reference internal" href="Decode.html#module-kospeech.decode.search">Search</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Evaluator.html">Evaluator</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Evaluator.html#id1">Evaluator</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Optim.html">Optim</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Optim.html#module-kospeech.optim.loss">Loss</a></li>
<li class="toctree-l2"><a class="reference internal" href="Optim.html#module-kospeech.optim.lr_scheduler">LrScheduler</a></li>
<li class="toctree-l2"><a class="reference internal" href="Optim.html#id1">Optim</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Trainer.html">Trainer</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Trainer.html#module-kospeech.trainer.supervised_trainer">SupervisedTrainer</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Etc.html">Etc</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Etc.html#module-kospeech.metrics">Metrics</a></li>
<li class="toctree-l2"><a class="reference internal" href="Etc.html#module-kospeech.model_builder">ModelBuilder</a></li>
<li class="toctree-l2"><a class="reference internal" href="Etc.html#module-kospeech.opts">Opts</a></li>
<li class="toctree-l2"><a class="reference internal" href="Etc.html#module-kospeech.utils">Utils</a></li>
</ul>
</li>
</ul>
</div>
</div>


           </div>
           
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="notes/intro.html" class="btn btn-neutral float-right" title="Intro" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2020, Soohwan Kim

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
  
    
   

</body>
</html>